<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: Bloomberg::quantum::ITerminate Interface Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d9/ddb/structBloomberg_1_1quantum_1_1ITerminate.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d5/deb/structBloomberg_1_1quantum_1_1ITerminate-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Bloomberg::quantum::ITerminate Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents an object which can be terminated. This interface allows certain objects to be explicitly disposed of before their destructors are called.  
 <a href="../../d9/ddb/structBloomberg_1_1quantum_1_1ITerminate.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../d2/dea/quantum__iterminate_8h_source.html">quantum_iterminate.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Bloomberg::quantum::ITerminate:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../d9/ddb/structBloomberg_1_1quantum_1_1ITerminate.png" usemap="#Bloomberg::quantum::ITerminate_map" alt=""/>
  <map id="Bloomberg::quantum::ITerminate_map" name="Bloomberg::quantum::ITerminate_map">
<area href="../../d0/da5/classBloomberg_1_1quantum_1_1Dispatcher.html" title="Parallel execution engine used to run coroutines or IO tasks asynchronously. This class is the main e..." alt="Bloomberg::quantum::Dispatcher" shape="rect" coords="0,56,229,80"/>
<area href="../../da/daa/classBloomberg_1_1quantum_1_1DispatcherCore.html" title="Class implementing the dispatching logic unto worker threads. Used for both coroutines and IO tasks." alt="Bloomberg::quantum::DispatcherCore" shape="rect" coords="239,56,468,80"/>
<area href="../../df/de4/structBloomberg_1_1quantum_1_1IPromiseBase.html" title="Exposes methods to manipulate and access a promise." alt="Bloomberg::quantum::IPromiseBase" shape="rect" coords="478,56,707,80"/>
<area href="../../d2/db0/structBloomberg_1_1quantum_1_1IQueue.html" title="Interface to a task queue. For internal use only." alt="Bloomberg::quantum::IQueue" shape="rect" coords="836,56,1065,80"/>
<area href="../../df/daf/structBloomberg_1_1quantum_1_1ITask.html" title="Interface to a task. For internal use only." alt="Bloomberg::quantum::ITask" shape="rect" coords="1314,56,1543,80"/>
<area href="../../d0/d96/structBloomberg_1_1quantum_1_1ITaskAccessor.html" title="Interface to a task accessor. For internal use only." alt="Bloomberg::quantum::ITaskAccessor" shape="rect" coords="1673,56,1902,80"/>
<area href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html" title="Class representing a promised value." alt="Bloomberg::quantum::Promise&lt; T &gt;" shape="rect" coords="478,112,707,136"/>
<area href="../../d4/dd1/classBloomberg_1_1quantum_1_1IoQueue.html" title="Thread queue for executing IO tasks." alt="Bloomberg::quantum::IoQueue" shape="rect" coords="717,112,946,136"/>
<area href="../../d8/d06/classBloomberg_1_1quantum_1_1TaskQueue.html" title="Thread queue for running coroutines." alt="Bloomberg::quantum::TaskQueue" shape="rect" coords="956,112,1185,136"/>
<area href="../../d4/d8b/classBloomberg_1_1quantum_1_1IoTask.html" title="Long running or blocking task running in the IO thread pool." alt="Bloomberg::quantum::IoTask" shape="rect" coords="1195,112,1424,136"/>
<area href="../../d4/d03/structBloomberg_1_1quantum_1_1ITaskContinuation.html" title="Interface to a task continuation. For internal use only." alt="Bloomberg::quantum::ITaskContinuation" shape="rect" coords="1434,112,1663,136"/>
<area href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html" title="Concrete class representing a coroutine or a thread context." alt="Bloomberg::quantum::Context&lt; RET &gt;" shape="rect" coords="1673,112,1902,136"/>
<area href="../../d0/d90/classBloomberg_1_1quantum_1_1Task.html" title="Runnable object representing a coroutine." alt="Bloomberg::quantum::Task" shape="rect" coords="1434,168,1663,192"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/dae/classBloomberg_1_1quantum_1_1ITerminate_1_1Guard.html">Guard</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4086a8ce16fc2482ee77701d387b14d8"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/ddb/structBloomberg_1_1quantum_1_1ITerminate.html#a4086a8ce16fc2482ee77701d387b14d8">~ITerminate</a> ()=default</td></tr>
<tr class="memdesc:a4086a8ce16fc2482ee77701d387b14d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. This function is explicitly left empty.  <a href="#a4086a8ce16fc2482ee77701d387b14d8">More...</a><br /></td></tr>
<tr class="separator:a4086a8ce16fc2482ee77701d387b14d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66e42ce854b5afbb7742c5ffdaae8503"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/ddb/structBloomberg_1_1quantum_1_1ITerminate.html#a66e42ce854b5afbb7742c5ffdaae8503">terminate</a> ()=0</td></tr>
<tr class="memdesc:a66e42ce854b5afbb7742c5ffdaae8503"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates the object.  <a href="#a66e42ce854b5afbb7742c5ffdaae8503">More...</a><br /></td></tr>
<tr class="separator:a66e42ce854b5afbb7742c5ffdaae8503"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents an object which can be terminated. This interface allows certain objects to be explicitly disposed of before their destructors are called. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4086a8ce16fc2482ee77701d387b14d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4086a8ce16fc2482ee77701d387b14d8">&#9670;&nbsp;</a></span>~ITerminate()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Bloomberg::quantum::ITerminate::~ITerminate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual destructor. This function is explicitly left empty. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a66e42ce854b5afbb7742c5ffdaae8503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66e42ce854b5afbb7742c5ffdaae8503">&#9670;&nbsp;</a></span>terminate()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Bloomberg::quantum::ITerminate::terminate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Terminates the object. </p>
<dl class="section note"><dt>Note</dt><dd>This method should contain all logic necessary to properly cleanup this instance. </dd></dl>

<p>Implemented in <a class="el" href="../../d0/da5/classBloomberg_1_1quantum_1_1Dispatcher.html#ab8715f18ec4dc05c89b0062701ef17a6">Bloomberg::quantum::Dispatcher</a>, <a class="el" href="../../d8/d06/classBloomberg_1_1quantum_1_1TaskQueue.html#addcace6a6fc8ec654f3d46c97d47e14a">Bloomberg::quantum::TaskQueue</a>, <a class="el" href="../../d0/d90/classBloomberg_1_1quantum_1_1Task.html#ace92bcfa7735b46ec46dd550006c144f">Bloomberg::quantum::Task</a>, <a class="el" href="../../d4/d8b/classBloomberg_1_1quantum_1_1IoTask.html#ac50a75d6d38d156e5b96a1d0761827ab">Bloomberg::quantum::IoTask</a>, <a class="el" href="../../d8/df7/classBloomberg_1_1quantum_1_1Context.html#a8bac8f4101d8469756bb27b1c0b7f9dc">Bloomberg::quantum::Context&lt; RET &gt;</a>, <a class="el" href="../../d4/dd1/classBloomberg_1_1quantum_1_1IoQueue.html#a04095064b96d22100d250607d4fcd4b8">Bloomberg::quantum::IoQueue</a>, <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html#a899050b84c34d99031cbca8a195d1148">Bloomberg::quantum::Promise&lt; T &gt;</a>, and <a class="el" href="../../da/daa/classBloomberg_1_1quantum_1_1DispatcherCore.html#a2dacf07e91eac243eb8f04fd15439a68">Bloomberg::quantum::DispatcherCore</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></li><li class="navelem"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">quantum</a></li><li class="navelem"><a class="el" href="../../d9/ddb/structBloomberg_1_1quantum_1_1ITerminate.html">ITerminate</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
